docs: add Notebook 1 — Inspecting a Generated World (M14)#48
Merged
Conversation
Jupyter notebook walking users through generating a small bundle and exploring its contents: manifest, relational tables, FK relationships, task splits, dataset card, and feature dictionary. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
shaypal5
added
type: docs
This comment has been minimized.
This comment has been minimized.
…manifest - Register atexit handler so temp dir is cleaned up even if the kernel restarts or a cell errors before the cleanup cell runs. - Read task ID from manifest instead of hardcoding "converted_within_90_days" — aligns with the recently added primary_task configurability. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Pull request overview
This PR adds the first example notebook for the leadforge bundle format, giving users a guided walkthrough of generating a small synthetic world and inspecting the bundle artifacts it produces. It fits into the codebase as end-user documentation for the public Python API and the bundle schema/layout already implemented elsewhere in the repository.
Changes:
- Adds
leadforge/examples/notebooks/01_inspect_world.ipynb, covering bundle generation, manifest inspection, relational tables, task splits, dataset card, and feature dictionary. - Uses a small generated bundle (
n_leads=500,seed=42,student_public,intro) to keep the notebook fast and self-contained. - Marks M14 Notebook 1 as completed in
.agent-plan.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
leadforge/examples/notebooks/01_inspect_world.ipynb |
New walkthrough notebook demonstrating how to generate and inspect a bundle with the Python API. |
.agent-plan.md |
Updates roadmap status to mark Notebook 1 as done. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…pyter prereq - Task manifest uses flat keys (train_rows, valid_rows) not nested dicts — fixed the manifest display cell to match actual schema. - Added Jupyter install note to prerequisites markdown cell. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
pr-agent-context report: No unresolved review comments, failing checks, or actionable patch coverage gaps were found on PR #48 in repository https://github.com/leadforge-dev/leadforge. Treat this PR as all clear unless new signals appear.Run metadata: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
leadforge/examples/notebooks/01_inspect_world.ipynb— a Jupyter notebook that walks data scientists through generating a small bundle and exploring everything inside it.manifest.jsonprovenance, relational tables + FK relationships, task splits (class balance, feature distributions), dataset card, and feature dictionary..agent-plan.mdto mark M14 Notebook 1 as done.Design choices
tempfile.mkdtemp()for the bundle directory, cleaned up at the end — notebook is fully self-contained.research_instructormode without generating it.Test plan
pip install -e ".[dev]"then run the notebook end-to-end withjupyter nbconvert --execute🤖 Generated with Claude Code